====== autoindex Plugin ======

---- plugin ----
description: List namespace contents in a alphabetical index
author     : Andreas Gohr 
email      : gohr@cosmocode.de
type       : syntax
lastupdate : 2023-02-09
compatible : Igor
depends    : 
conflicts  : 
similar    : pagequery
tags       : index, list, navigation, glossary

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-autoindex/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-autoindex/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-autoindex/
donationurl: 

screenshot_img : 
----

This plugin lists all pages in the current namespace by their first heading, sorting them into sections named after the first character of that title.

It can be used to create simple alphabetical overview over the current namespace.

===== Installation =====

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Syntax and Usage =====

Currently there is only one simple macro supported:

  {{autoindex}}

No further configuration or settings are supported currently.

Notes:

  * The plugin honors [[:acl|ACLs]], but does this on rendering only. The (possibly user dependent) result may be cached. If you don't want that you need to disable caching for the page it is used on with ''%%~~NOCACHE~~%%''
  * Currently all pages directly in the current namespace are shown. No sub namespaces.